<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.math3.analysis.solvers;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import org.apache.commons.math3.analysis.UnivariateFunction;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    /**<a name="line.22"></a>
<FONT color="green">023</FONT>     * Interface for (univariate real) rootfinding algorithms.<a name="line.23"></a>
<FONT color="green">024</FONT>     * Implementations will search for only one zero in the given interval.<a name="line.24"></a>
<FONT color="green">025</FONT>     *<a name="line.25"></a>
<FONT color="green">026</FONT>     * This class is not intended for use outside of the Apache Commons Math<a name="line.26"></a>
<FONT color="green">027</FONT>     * library, regular user should rely on more specific interfaces like<a name="line.27"></a>
<FONT color="green">028</FONT>     * {@link UnivariateSolver}, {@link PolynomialSolver} or {@link<a name="line.28"></a>
<FONT color="green">029</FONT>     * DifferentiableUnivariateSolver}.<a name="line.29"></a>
<FONT color="green">030</FONT>     * @param &lt;FUNC&gt; Type of function to solve.<a name="line.30"></a>
<FONT color="green">031</FONT>     *<a name="line.31"></a>
<FONT color="green">032</FONT>     * @since 3.0<a name="line.32"></a>
<FONT color="green">033</FONT>     * @version $Id: BaseUnivariateSolver.java 1364387 2012-07-22 18:14:11Z tn $<a name="line.33"></a>
<FONT color="green">034</FONT>     * @see UnivariateSolver<a name="line.34"></a>
<FONT color="green">035</FONT>     * @see PolynomialSolver<a name="line.35"></a>
<FONT color="green">036</FONT>     * @see DifferentiableUnivariateSolver<a name="line.36"></a>
<FONT color="green">037</FONT>     */<a name="line.37"></a>
<FONT color="green">038</FONT>    public interface BaseUnivariateSolver&lt;FUNC extends UnivariateFunction&gt; {<a name="line.38"></a>
<FONT color="green">039</FONT>        /**<a name="line.39"></a>
<FONT color="green">040</FONT>         * Get the maximum number of function evaluations.<a name="line.40"></a>
<FONT color="green">041</FONT>         *<a name="line.41"></a>
<FONT color="green">042</FONT>         * @return the maximum number of function evaluations.<a name="line.42"></a>
<FONT color="green">043</FONT>         */<a name="line.43"></a>
<FONT color="green">044</FONT>        int getMaxEvaluations();<a name="line.44"></a>
<FONT color="green">045</FONT>    <a name="line.45"></a>
<FONT color="green">046</FONT>        /**<a name="line.46"></a>
<FONT color="green">047</FONT>         * Get the number of evaluations of the objective function.<a name="line.47"></a>
<FONT color="green">048</FONT>         * The number of evaluations corresponds to the last call to the<a name="line.48"></a>
<FONT color="green">049</FONT>         * {@code optimize} method. It is 0 if the method has not been<a name="line.49"></a>
<FONT color="green">050</FONT>         * called yet.<a name="line.50"></a>
<FONT color="green">051</FONT>         *<a name="line.51"></a>
<FONT color="green">052</FONT>         * @return the number of evaluations of the objective function.<a name="line.52"></a>
<FONT color="green">053</FONT>         */<a name="line.53"></a>
<FONT color="green">054</FONT>        int getEvaluations();<a name="line.54"></a>
<FONT color="green">055</FONT>    <a name="line.55"></a>
<FONT color="green">056</FONT>        /**<a name="line.56"></a>
<FONT color="green">057</FONT>         * Get the absolute accuracy of the solver.  Solutions returned by the<a name="line.57"></a>
<FONT color="green">058</FONT>         * solver should be accurate to this tolerance, i.e., if &amp;epsilon; is the<a name="line.58"></a>
<FONT color="green">059</FONT>         * absolute accuracy of the solver and {@code v} is a value returned by<a name="line.59"></a>
<FONT color="green">060</FONT>         * one of the {@code solve} methods, then a root of the function should<a name="line.60"></a>
<FONT color="green">061</FONT>         * exist somewhere in the interval ({@code v} - &amp;epsilon;, {@code v} + &amp;epsilon;).<a name="line.61"></a>
<FONT color="green">062</FONT>         *<a name="line.62"></a>
<FONT color="green">063</FONT>         * @return the absolute accuracy.<a name="line.63"></a>
<FONT color="green">064</FONT>         */<a name="line.64"></a>
<FONT color="green">065</FONT>        double getAbsoluteAccuracy();<a name="line.65"></a>
<FONT color="green">066</FONT>    <a name="line.66"></a>
<FONT color="green">067</FONT>        /**<a name="line.67"></a>
<FONT color="green">068</FONT>         * Get the relative accuracy of the solver.  The contract for relative<a name="line.68"></a>
<FONT color="green">069</FONT>         * accuracy is the same as {@link #getAbsoluteAccuracy()}, but using<a name="line.69"></a>
<FONT color="green">070</FONT>         * relative, rather than absolute error.  If &amp;rho; is the relative accuracy<a name="line.70"></a>
<FONT color="green">071</FONT>         * configured for a solver and {@code v} is a value returned, then a root<a name="line.71"></a>
<FONT color="green">072</FONT>         * of the function should exist somewhere in the interval<a name="line.72"></a>
<FONT color="green">073</FONT>         * ({@code v} - &amp;rho; {@code v}, {@code v} + &amp;rho; {@code v}).<a name="line.73"></a>
<FONT color="green">074</FONT>         *<a name="line.74"></a>
<FONT color="green">075</FONT>         * @return the relative accuracy.<a name="line.75"></a>
<FONT color="green">076</FONT>         */<a name="line.76"></a>
<FONT color="green">077</FONT>        double getRelativeAccuracy();<a name="line.77"></a>
<FONT color="green">078</FONT>    <a name="line.78"></a>
<FONT color="green">079</FONT>        /**<a name="line.79"></a>
<FONT color="green">080</FONT>         * Get the function value accuracy of the solver.  If {@code v} is<a name="line.80"></a>
<FONT color="green">081</FONT>         * a value returned by the solver for a function {@code f},<a name="line.81"></a>
<FONT color="green">082</FONT>         * then by contract, {@code |f(v)|} should be less than or equal to<a name="line.82"></a>
<FONT color="green">083</FONT>         * the function value accuracy configured for the solver.<a name="line.83"></a>
<FONT color="green">084</FONT>         *<a name="line.84"></a>
<FONT color="green">085</FONT>         * @return the function value accuracy.<a name="line.85"></a>
<FONT color="green">086</FONT>         */<a name="line.86"></a>
<FONT color="green">087</FONT>        double getFunctionValueAccuracy();<a name="line.87"></a>
<FONT color="green">088</FONT>    <a name="line.88"></a>
<FONT color="green">089</FONT>        /**<a name="line.89"></a>
<FONT color="green">090</FONT>         * Solve for a zero root in the given interval.<a name="line.90"></a>
<FONT color="green">091</FONT>         * A solver may require that the interval brackets a single zero root.<a name="line.91"></a>
<FONT color="green">092</FONT>         * Solvers that do require bracketing should be able to handle the case<a name="line.92"></a>
<FONT color="green">093</FONT>         * where one of the endpoints is itself a root.<a name="line.93"></a>
<FONT color="green">094</FONT>         *<a name="line.94"></a>
<FONT color="green">095</FONT>         * @param maxEval Maximum number of evaluations.<a name="line.95"></a>
<FONT color="green">096</FONT>         * @param f Function to solve.<a name="line.96"></a>
<FONT color="green">097</FONT>         * @param min Lower bound for the interval.<a name="line.97"></a>
<FONT color="green">098</FONT>         * @param max Upper bound for the interval.<a name="line.98"></a>
<FONT color="green">099</FONT>         * @return a value where the function is zero.<a name="line.99"></a>
<FONT color="green">100</FONT>         * @throws org.apache.commons.math3.exception.MathIllegalArgumentException<a name="line.100"></a>
<FONT color="green">101</FONT>         * if the arguments do not satisfy the requirements specified by the solver.<a name="line.101"></a>
<FONT color="green">102</FONT>         * @throws org.apache.commons.math3.exception.TooManyEvaluationsException if<a name="line.102"></a>
<FONT color="green">103</FONT>         * the allowed number of evaluations is exceeded.<a name="line.103"></a>
<FONT color="green">104</FONT>         */<a name="line.104"></a>
<FONT color="green">105</FONT>        double solve(int maxEval, FUNC f, double min, double max);<a name="line.105"></a>
<FONT color="green">106</FONT>    <a name="line.106"></a>
<FONT color="green">107</FONT>        /**<a name="line.107"></a>
<FONT color="green">108</FONT>         * Solve for a zero in the given interval, start at {@code startValue}.<a name="line.108"></a>
<FONT color="green">109</FONT>         * A solver may require that the interval brackets a single zero root.<a name="line.109"></a>
<FONT color="green">110</FONT>         * Solvers that do require bracketing should be able to handle the case<a name="line.110"></a>
<FONT color="green">111</FONT>         * where one of the endpoints is itself a root.<a name="line.111"></a>
<FONT color="green">112</FONT>         *<a name="line.112"></a>
<FONT color="green">113</FONT>         * @param maxEval Maximum number of evaluations.<a name="line.113"></a>
<FONT color="green">114</FONT>         * @param f Function to solve.<a name="line.114"></a>
<FONT color="green">115</FONT>         * @param min Lower bound for the interval.<a name="line.115"></a>
<FONT color="green">116</FONT>         * @param max Upper bound for the interval.<a name="line.116"></a>
<FONT color="green">117</FONT>         * @param startValue Start value to use.<a name="line.117"></a>
<FONT color="green">118</FONT>         * @return a value where the function is zero.<a name="line.118"></a>
<FONT color="green">119</FONT>         * @throws org.apache.commons.math3.exception.MathIllegalArgumentException<a name="line.119"></a>
<FONT color="green">120</FONT>         * if the arguments do not satisfy the requirements specified by the solver.<a name="line.120"></a>
<FONT color="green">121</FONT>         * @throws org.apache.commons.math3.exception.TooManyEvaluationsException if<a name="line.121"></a>
<FONT color="green">122</FONT>         * the allowed number of evaluations is exceeded.<a name="line.122"></a>
<FONT color="green">123</FONT>         */<a name="line.123"></a>
<FONT color="green">124</FONT>        double solve(int maxEval, FUNC f, double min, double max, double startValue);<a name="line.124"></a>
<FONT color="green">125</FONT>    <a name="line.125"></a>
<FONT color="green">126</FONT>        /**<a name="line.126"></a>
<FONT color="green">127</FONT>         * Solve for a zero in the vicinity of {@code startValue}.<a name="line.127"></a>
<FONT color="green">128</FONT>         *<a name="line.128"></a>
<FONT color="green">129</FONT>         * @param f Function to solve.<a name="line.129"></a>
<FONT color="green">130</FONT>         * @param startValue Start value to use.<a name="line.130"></a>
<FONT color="green">131</FONT>         * @return a value where the function is zero.<a name="line.131"></a>
<FONT color="green">132</FONT>         * @param maxEval Maximum number of evaluations.<a name="line.132"></a>
<FONT color="green">133</FONT>         * @throws org.apache.commons.math3.exception.MathIllegalArgumentException<a name="line.133"></a>
<FONT color="green">134</FONT>         * if the arguments do not satisfy the requirements specified by the solver.<a name="line.134"></a>
<FONT color="green">135</FONT>         * @throws org.apache.commons.math3.exception.TooManyEvaluationsException if<a name="line.135"></a>
<FONT color="green">136</FONT>         * the allowed number of evaluations is exceeded.<a name="line.136"></a>
<FONT color="green">137</FONT>         */<a name="line.137"></a>
<FONT color="green">138</FONT>        double solve(int maxEval, FUNC f, double startValue);<a name="line.138"></a>
<FONT color="green">139</FONT>    }<a name="line.139"></a>




























































</PRE>
</BODY>
</HTML>
